RocketChat Integration

A RocketChat integration with Cloudhouse Guardian (Guardian) allows you to trigger RocketChat messages to be sent after certain events take place. For example, in the event of a failed scan, you can configure this as an Action that automatically sends a RocketChat message every time a scan fails in your Guardian instance. This topic describes the steps you need to complete to setup a RocketChat integration to Guardian.

Note: This topic focuses on setting up the RocketChat integration. If you've already set up the integration and want to configure RocketChat actions, see Action: Send a Message to RocketChat.

Dependencies

To add a RocketChat integration, a RocketChat user account is required. This could be an existing user account, but we recommend setting up a brand new user account named 'Guardian' for easier identification. You will need the user account’s username and password.

Add RocketChat Integration

Integrating RocketChat withGuardianestablishes a seamless connection to trigger RocketChat messages to be sent after certain events take place.

To add a RocketChat integration to Guardian, complete the following:

  1. In the Guardian web application, navigate to the Integrations tab (Control > Integrations) and click Add Integration. The Add Integration page is displayed.

  2. Select RocketChat from the list of available integrations. Here, you are required to complete the following options:

    Option

    Description

    Server URL field

    The base URL to the RocketChat server. For example,https://my.rocket.chat.

    Channel field

    The name of the RocketChat channel that messages will be posted to. For example, '#general' or '#qa-team'.

    Username field

    The username of the RocketChat account that the messages will be posted under.

    Password field

    The password for the corresponding RocketChat user account.

  3. Once you have set the correct values for each of the options displayed, click Done to create the RocketChat integration.

If successful, a confirmation message is displayed and the RocketChat integration is added to the Integrationstab of yourGuardian instance. You'll also receive a test message by a bot in the RocketChat channel you provided while adding the RocketChat integration. If unsuccessful, an error message is displayed. Use the information displayed in the error message(s) to troubleshoot the values in your RocketChat Integration options.

Troubleshooting

If you are experiencing issues with your integration, try the following:

  • Verify that the values supplied for the integration are correct.

  • To confirm the status of the integration sync, check the integration sync event in the Events tab (Control > Events) of your Guardian instance. For more information, see Events.